Skip to main content

Get Destination

Route

/v2/streaming/destinations/{destination_id}

Description

Retrieve detailed information about a specific streaming destination, including configuration and status.

Method

GET

Inputs

ParameterTypeRequiredDescription
destination_idstringYesUnique identifier of the destination to retrieve

Path Parameters

  • destination_id: The unique identifier of the destination (provided in the URL path)

Request Example

GET /v2/streaming/destinations/dest-123

Output

FieldTypeDescription
idstringUnique destination identifier
namestringDestination name
descriptionstringDestination description
typestringDestination type (always "https")
formatstringData format (json, json_lines)
encodingstringEncoding type (none, gzip)
https_configobjectHTTPS configuration details
statusstringDestination status (active, inactive, error)
last_activitystringLast successful data transmission (ISO 8601)
created_atstringCreation timestamp (ISO 8601)
updated_atstringLast update timestamp (ISO 8601)

HTTPS Config Object

FieldTypeDescription
uristringHTTPS endpoint URL
timeout_secondsintegerRequest timeout in seconds
headersobjectCustom HTTP headers (sensitive values masked)

Rate Limit

  • 60 requests per minute per API key
  • 5 concurrent requests per endpoint

Example Response

{
"id": "dest-123",
"name": "SIEM Integration",
"description": "Stream to Splunk SIEM",
"type": "https",
"format": "json_lines",
"encoding": "gzip",
"https_config": {
"uri": "https://splunk.company.com/services/collector/event",
"timeout_seconds": 60,
"headers": {
"Authorization": "***masked***"
}
},
"status": "active",
"last_activity": "2024-01-15T11:30:00Z",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}

Usage Notes

  • Sensitive header values (like authorization tokens) are masked in the response
  • Status indicates current operational state of the destination
  • last_activity shows when data was last successfully transmitted